SJT 11291-2003 面向对象的软件系统建模规范 第3部分 文档编制
ID: |
D413C36783A9454CB78F54AA9828C576 |
文件大小(MB): |
0.9 |
页数: |
15 |
文件格式: |
|
日期: |
2024-7-28 |
购买: |
文本摘录(文本识别可能有误,但文件阅览显示及打印正常,pdf文件可进行文字搜索定位):
ICS 35.008,L77,备案号:12036—2003,中华人民共和国电子行业标准,SJ/T 11291—2003,面向对象的软件系统建模规范,第3部分:文档编制,Specification of object-oriented software system modeling,Part 3: Documentation,2003-06-04 发布2003-10-0I 实施,中华人民共和国信息产业部 发布,SJ/T 11291—2003,前 言,《面向对象的软件系统建模规范》系列标准分为三部分:,SJ/T 11290—2003《面向对象的软件系统建模规范第1部分:概念与表示法》,SJ/T XXXX—XXXX《面向对象的软件系统建模规范第2部分:过程指导》,SJ/T 11291—2003《面向对象的软件系统建模规范第3部分:文档编制》,附录A是资料性附录.,本标准由中国电子技术标准化研究所归ロ,本标准由北京大学负责起草.,本标准主要起草人:麻志毅、蒋严冰、王立福、邵维忠,I,SJ/T 11291—2003,引 言,文档是软件的重要组成部分,是对研制过程进行管理的重要手段中文档的形式可以是多种多样的口,在面向对象的软件系统建模过程中经常用到的文档,可以是图形的,也可以是文本的。形文档具有清,晰,直观及简练等特点;文本文档具有容易理解、具体及详细等特点.二者相互补充和相互依赖,都是,不可少的。在本标准中要求同时使用这两种文档中其中的图形文档的绘制方法在SJ" 11290—2003《面,向对象的软件系统建模规范 第1部分:概念和表示法》中已有了详细的规定口本标准主要规定与各图,形文档相对应的文本文档格式,严格地说,尽管图形文档和文本文档的表现形式不同,但其本质内容都是一致的0在编制的过程中,要充分地注意到这一点,カ求图形文档中的元素和文本文档中的各组成部分ーー对应。在每种文本文档,中对各个组成部分分类描述,并注重描述不同组成部分的关系,这样就使得文本文档中的组成部分组织,严密,便于相关人员从不同的角度使用所需要的组成部分口,在图形文档中,为了管理信息组织的复杂度而引入了包的机制。为了更好地用文本的方式描述这种,机制,在本标准中用递归的方法描述带有包的文档ロ,本标准对用况图文档、类图文档、顺序图文档、协作图文档、状态图文档、活动图文档、构件图文,档、部署图文档和包图文档的格式分别做了详细的描述,对每种文档的结构以及可能包含的组成部分分,别出了规定。本标准最后提供了一个样式,以便于有关人员实际操作时参考,n,SJ/T 11291—2003,面向对象的软件系统建模规范,第3部分:文档编制,1范围,本标准规定了对面向对象的软件系统建模过程中所生成的文档的编制要求,并给出了编制提示。本,部分适用于软件系统的分析和设计, 和维护□,2引用标准,一考一,J,第2部分:过程指导》开发软件系统时,可以按开,R,2003,'4 「丒丒/,ロ,下列文件中的条宗,修改单,是否可使用这些党件的最,SJ/T1129,SJfTX,3文档的皤リ要绕,在ー个面,总体说,用况图,类图文槿;,顺序图,协作图文,状态图文档;,活动图文档:,构件图文档;,部署图文档;,而成为本标准的条累I用文件.其随后所有的,据本标椎达成协议的各方研究,本や凡是不注日期的引用文件,其最新,象的软件系统建模规范 第1部分:i,适用于本标准.,的向对象触:件系納模规范第2部ケ甲网,脚アア般地说,应产生下列文粒限,其中有的文档有时会引入,开发者也可根据所承担项目的实耐察,当开发者按照《面向对象的软件系统建模规范,发阶段组织文档,分别形成:,需求定义文档、分析文档和设计文档,跟 岫 曲№№№№1I 附 W iWrt",期,示法,〇,其中每种文档的内容包含一个或多个上面提到的各种图的文档,具体的要求见《面向对象的软件系,统建模规范第2部分:过程指导况,4文档的编写提示,4.1总体说明文档,以文本方式,对整个系统作一些必要的说明。内容包括系统的目标、意义、应用范围、项目背景和,文档组成等。但不必对系统的总体进行详细地说明,只需作提纲挈领式的简单介绍。另外,还要说明系,统的建模文档由那几种具体的文档组成、每种文档的份数以及对各种文档的组织等Q,4*2用况图文档,SJ/T 11291—2003,4. 2. 1 形文档,即所绘制的用况图,4.2.2文字说明,用况图文档由以下部分组成:用况图综述、参与者描述、用况描述、用况图中元素间的关系描述和,其他与用况图有关的说明,4. 2. 2.1用况图综述,从总体上阐述整个用况图的目的、结构、功能以及组织。以文字描述文档所包含的部分,4. 2. 2. 2参与者描述,列出一个用况图中的每个参与者的名称,可按字母顺序或其它某种有规律的次序排列。必要时要对,参与者附有必要的文字说明,也可以说明它所涉及到的用况和交互图的名称,4. 2.2. 3用况描述,对于ー个用况图中的每个用况,记录如下的信息。要按某种顺序排列它们.,a)名称,每个用况有一个在图内唯一的名字,并且该名字要反映出它所描述的功能。书写位置是在用况,描述的第一行,b)行为描述,用自然语言分别描述参与者的行为和系统行为,建议把参与者的行为靠左对齐书写,把系统行,为靠较右的位置对齐书写,在描述较复杂的含有循环或条件分支的行为时,可使用一些结构化编程语言的控制语句,如,while, for, if-then-else 等,当要表明控制语句的作用范围时,可使用括号,如{ヽ}或begin、end等,也可以使用标号,以便更清楚地表示控制走向,如有必要,可使用顺序图、状态……
……